Simulate bankslip payment conclusion

Sandbox environment only

This simulation endpoint is available only in the homologation environment. Do not use this route in production flows.

Use this route to simulate the conclusion of a bankslip charge in the homologation environment.

You can simulate the conclusion by bankslip data or by Pix. When using PIX, pass the bankslip correlationId in the {id} path parameter.

Request

URL

POST 'https://apisandbox.delbank.com.br/baas/v1/charges/{id}/simulate-conclude'

cURL

curl --request POST \
     --url 'https://apisandbox.delbank.com.br/baas/v1/charges/{id}/simulate-conclude' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-delbank-api-key: {{apiKey}}' \
     --header 'x-delfinance-account-id: {{accountId}}' \
     --data '{"type":"BANKSLIP"}'

Headers

Name	Description
x-delbank-api-key	Required. API key
x-delfinance-account-id	Required. The Delfinance bank account number

Path parameters

Name	Type	Description
id	string	Required. Bankslip charge identifier. For BANKSLIP, use the digitable line or the barcode. For PIX, use the bankslip correlationId.

Request body

Name	Type	Description
type	string	Required. Simulation type. Use BANKSLIP or PIX.

Request body example

Bankslip

{
  "type": "BANKSLIP"
}

Pix

{
  "type": "PIX"
}

Response

The expected response is 202 Accepted.

{
  "correlationId": "string",
  "referenceId": "string",
  "amount": 150.5,
  "source": "PCR",
  "date": "2026-05-21T13:30:15Z",
  "paymentDate": "2026-05-21T13:30:15Z",
  "issuer": {
    "ispb": "string",
    "code": "string",
    "branch": "string",
    "agency": "string",
    "name": "string",
    "type": "PJ",
    "document": "string",
    "fantasyName": "string"
  },
  "additionalData": {
    "simulator": "DelbankSimulator",
    "message": "Pagamento de boleto simulado em ambiente de homologação",
    "bankAccount": "string",
    "correlationId": "string",
    "ourNumber": "string",
    "barCode": "string",
    "digitableLine": "string"
  }
}

Possible errors

Payment type not informed

Status: 400 Bad Request

{
  "title": "Please refer to the errors property for additional details.",
  "errors": [
    "Tipo de pagamento não pode ser nulo"
  ]
}

Invalid type

Status: 400 Bad Request

{
  "title": "Please refer to the errors property for additional details.",
  "errors": [
    "Tipo de pagamento inválido"
  ]
}

Identifier not informed

Status: 400 Bad Request

{
  "title": "Please refer to the errors property for additional details.",
  "errors": [
    "Identificador da cobrança deve ser informado"
  ]
}